package itsm.isperp.framework.data.commons.repository;

import java.io.Serializable;

import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.Repository;
import org.springframework.stereotype.Component;

/**
 * 一个具有查询及操作数据实体的接口，继承于 {@link CrudRepository}
 * 
 * @author lizx
 * @date 2012-11-13
 * @version V1.0
 */
@Component
public interface GenericRepository<T, ID extends Serializable> extends
		Repository<T, ID> {

	/**
	 * Saves a given entity. Use the returned instance for further operations as
	 * the save operation might have changed the entity instance completely.
	 * 
	 * @param entity
	 *            实体
	 * @return 保存的条数
	 */
	<S extends T> int save(S entity);

	/**
	 * 更新实体对象
	 * 
	 * @param entity
	 *            实体
	 */
	<S extends T> void update(S entity);

 

	/**
	 * 保存所有实体。
	 * 
	 * @param entities
	 *            　实体列表
	 * @return 保存的条数
	 * @throws IllegalArgumentException
	 *             in case the given entity is (@literal null}.
	 */
	<S extends T> int save(Iterable<S> entities);

	/**
	 * Retrives an entity by its id.
	 * 
	 * @param id
	 *            must not be {@literal null}.
	 * @return the entity with the given id or {@literal null} if none found
	 * @throws IllegalArgumentException
	 *             if {@code id} is {@literal null}
	 */
	T findOne(ID id);

	/**
	 * Returns whether an entity with the given id exists.
	 * 
	 * @param id
	 *            must not be {@literal null}.
	 * @return true if an entity with the given id exists, alse otherwise
	 * @throws IllegalArgumentException
	 *             if {@code id} is {@literal null}
	 */
	boolean exists(ID id);

	//
	// /**
	// * Returns all instances of the type.
	// *
	// * @return all entities
	// */
	// List<T> findAll();
	//
	// /**
	// * Returns all instances of the type with the given IDs.
	// *
	// * @param ids
	// * @return
	// */
	// List<T> findAll(Iterable<ID> ids);

	/**
	 * Deletes the entity with the given id.
	 * 
	 * @param id
	 *            must not be {@literal null}.
	 * @throws IllegalArgumentException
	 *             in case the given {@code id} is {@literal null}
	 */
	void delete(ID id);

	// /**
	// * Deletes a given entity.
	// *
	// * @param entity
	// * @throws IllegalArgumentException
	// * in case the given entity is (@literal null}.
	// */
	// void delete(T entity);

	/**
	 * Deletes the given entities.
	 * 
	 * @param entities
	 * @throws IllegalArgumentException
	 *             in case the given {@link Iterable} is (@literal null}.
	 */
	void delete(Iterable<? extends T> entities);

	/**
	 * Deletes all entities managed by the repository.
	 */
	void deleteAll();

}
